'''A module containing most of the external settings for the script(s).'''
############################################################################
#    Copyright (C) 2006 by Robert Small                                    #
#    SmallR2002@Gmail.com                                                    #
#                                                                          #
#    This program is free software; you can redistribute it and#or modify  #
#    it under the terms of the GNU General Public License as published by  #
#    the Free Software Foundation; either version 2 of the License, or     #
#    (at your option) any later version.                                   #
#                                                                          #
#    This program is distributed in the hope that it will be useful,       #
#    but WITHOUT ANY WARRANTY; without even the implied warranty of        #
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         #
#    GNU General Public License for more details.                          #
#                                                                          #
#    You should have received a copy of the GNU General Public License     #
#    along with this program; if not, write to the                         #
#    Free Software Foundation, Inc.,                                       #
#    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             #
############################################################################

__module_name__        = "bcsettings"
__module_version__     = "0.0.2"
__module_description__ = "A module containing most of the external settings for the script(s)"

import platform
from socket import gethostname

# READ, do NOT copy and use! Read for help creating your own.

################################################################################################
################################################################################################
#                                      PERSONAL INFORMATION                                    #
################################################################################################
# Please only enter this if you want to, feel free to enter exactly how much you feel able to 
#give out and no more. You do not have to change anything here but please don't delete these
#lines as that would (like deleting any other line) break BottleCap.

# A nickname you'd like to be reported to us, you could use this to slightly personalise the 
#information we recieve without being too precise about who you are.
pd_nickname = "Nickname"

# A rough location you'd like to give us, maybe your county or a local city.
pd_district = "N/A"

# Your country. Please use the 'standard' English name for your country if you want to fill this
#in. Names in other languages won't help us much.
pd_country = "Cambodia"

# Please uncomment the second line if you want to give us your hostname.
pd_hostname = gethostname()

# Please uncomment the second line if you want to give us some basic information about your pc
pd_extplatform = platform.platform().replace("-", " ")

################################################################################################
################################################################################################
#                                    MODULE LOADING SETTINGS                                   #
################################################################################################

#  This is an implicit list of the modules BottleCap will load, please be sensible and think.
# This is the only place to change settings for what's loaded and what's not now, be careful.

#Currently avaliable modules are in bottlecap/ do not put bcsettings or bcmisc here.
#modules_to_load = ["bcbailiff",
#                   "bcclones",
#                   "bccorrector",
#                   "bchighlight",
#                   "bcinvite",
#                   "bcnotify",
#                   "bcoperfunctions",
#                   "bcphrasebook",
#                   "bcpurser",
#                   "bcregexpban",
#                   "bcroam",
#                   "bcenpea"
#                   ]

modules_to_load = ["bcbailiff",
                   "bcclones",
                   "bccorrector",
                   "bchighlight",
                   "bcinvite",
#                   "bcnotify" Windows and Mac can't use this...
                   "bcphrasebook",
                   "bcregexpban",
                   "bcroam"
                   ]

################################################################################################
################################################################################################
#                               SPELLING/PUNCTUATION CORRECTION                                #
################################################################################################

#  Should we make corrected text red, and add '[caps]' to converted caps lines?
show_corrections = True


################################################################################################
################################################################################################
#                                          AUTO AWAY                                           #
################################################################################################

#  The message to use when you're put to away automatically, might be an idea to finish it with
# [auto] so people know that you're automatically away and didn't set it yourself.
auto_away_message = "[auto] I'm currently not at the computer, or busy doing something. If you need help please read the page on getting help here: www.v8d.org/index.php?page=help or join the #help channel. You may find help in #chat or #v8d as well."

#  The time that is taken before it puts you to away. This may not always be exact as it is
# triggered by a message from the other side. 100.00 is ten minutes.
last_commands_time_out = 1000.00

#Deprecited:
#  Will the script actually put you into auto away?
#auto_away = True

# Should I return you?
auto_return = True

# Should I return you everywhere?
auto_return_global = True

# Remove this line to prove you've read the config!
#not_read_config = True

################################################################################################
################################################################################################
#                                     AUTO JOIN ON INVITE!                                     #
################################################################################################





#  Auto join when anyone invites you. Not advised...
auto_join_all_invite = True

#  Auto join when you invite yourself. Before someone asks why, some ircds allow opers to get
# round +i rooms by inviting themselves. Just takes one step away from disabling a botnet.
auto_join_self_invite = True

#  Auto join when you get invited from the following list. I use this for when I want to get my
# other client (another laptop a few feet away, i know, it's sad) to join a room I just joined.
auto_join_list_invite = True

#  List of people to accept invites from, read above. My advise is only put opers/friends on.
# People seem to like abusing something like this.
auto_join_list = [
        "SmilingJoker",
        "Smiling-Joker",
        "Smiling_Joker",
        "SmallR2002",
        "SmallR2003",
        "SmallR2004",
        "X3"
        ]
#End of array

#  Automatically reply when invited. This controls if the client sends a notice saying 'nope,
# not auto joining' or not.
auto_join_reply = False


################################################################################################
################################################################################################
#                               HIGHLIGHT AND RESPONSE SETTINGS!                               #
################################################################################################

# Remove this line to prove you've read the config!
#not_read_config = False

#  Enter your responses in here, the reason that there is the possibility of multiple options is
# so that you don't get kicked by an anti repeat script. Be sensible with what you write, 
highlight_response = [
        "Please don't repeatedly highlight me!",
        "Highlighting me once will get my attention, many times will get me annoyed.",
        "Don't do that...",
        "I don't like being highlighted repeatedly.",
        "Please don't be annoying.",
        "That's called being a dweeb, don't do it.",
        "Stop that please.",
        "I find that annoying, please don't do it.",
        "Can you please cease being annoying.",
        "Maybe I'm busy? Either way, you're being annoying."
        ]
#  The number of items in the above array -1, means you can have some ones but not use them.
highlight_responses = 9

#  The time it takes for a highlight to 'time out' resulting in the second highlight being
# ignored. By default I'd use 100.00, however, some of you may want faster or slower timeouts.
highlight_last_timeout = 100.00

#  This is the first of the two sets of values. It is IMPERATIVE that these two are CORRECTLY
# synced, or, it WILL NOT WORK. Really, honestly, doing it the right way will save you a work.
# highlight_channels_ban[1] should be the channel on the network specified in
# highlight_networks_ban[1]. This channel will have user banning on repeat highlightt allowed.
highlight_channels_ban = [
        "#chat",
        "#refuge",
        "#yami",
        "#linds",
        "#v8d"
        ]
#  Remember to sync the two...
highlight_networks_ban = [
        "V8d-pIRCs",
        "AfterNET",
        "V8d-pIRCs",
        "V8d-pIRCs",
        "V8d-pIRCs"
        ]


################################################################################################
################################################################################################
#                                    AUTO GIVE PERMISSIONS!                                    #
################################################################################################

#  These two are another two which MUST BE SYNCED. If they are not synced, it really honestly
# (and I have no reason to lie to you) will not work! The first is the channels, the second the
# networks. When in correct sync this will give +o to all users in the channel as they join.
# Oh, and, by the way, for those who are going to expect this to work if you don't have +o
# yourself, it wont ;).
auto_op_all_in_channels = [
        "#opers"
        ]
#  Sync them...
auto_op_all_in_networks = [
        "V8d-pIRCs"
        ]

# Remove this line to prove you've read the config!
#not_read_config = "A monkey"

#  Same as above, exactly the same, just gives +v instead of +o.
auto_voice_all_in_channels = [
        "#services"
        ]

auto_voice_all_in_networks = [
        "V8d-pIRCs"
        ]

################################################################################################
################################################################################################
#                                      LIBNOTIFY SUPPORT!                                      #
################################################################################################

libnotify_urgency_pm  = "low"
libnotify_urgency_hpm = "critical"
libnotify_urgency_cm  = "low"
libnotify_urgency_hcm = "critical"
#libnotify_urgency_wcm = "low"
#libnotify_urgency_tcm = "low"
libnotify_urgency_inv = "normal"

################################################################################################
################################################################################################
#                                        REGEXP BANNING                                        #
################################################################################################
regexp_ban_list = [
        "...\|([0-9]{4})"
        ]

################################################################################################
################################################################################################
#                                          BC BAILIFF                                          #
################################################################################################
bailiff_checkcaps = True
bailiff_checkpunctuation = True
bailiff_chans = [
                 "V8d-pIRCs #yami"
                 ]
bailiff_exempts = [
                   "UNICE"
                   ]

# Remove this line to prove you've read the config!
#not_read_config = True